---
layout: m1x_rest
title: Order Comments
---

<ul class="introduction-menu">
    <li><a href='#RESTAPI-Resource-OrderComments-RESTAPI-OrderComments'>REST API: Order Comments</a>
    <ul>
        <li><a href='#RESTAPI-Resource-OrderComments-URI--orders--orderid-comments'>URI: /orders/:orderid/comments</a>
        <ul>
            <li><a href='#RESTAPI-Resource-OrderComments-HTTPMethod-GET'>HTTP Method: GET</a></li>
            <li><a href='#RESTAPI-Resource-OrderComments-HTTPMethod-POST'>HTTP Method: POST</a></li>
            <li><a href='#RESTAPI-Resource-OrderComments-HTTPMethod-PUT'>HTTP Method: PUT</a></li>
            <li><a href='#RESTAPI-Resource-OrderComments-HTTPMethod-DELETE'>HTTP Method: DELETE</a></li>
        </ul>
        </li>
    </ul>
    </li>
    <li><a href='#RESTAPI-Resource-OrderComments-OrderCommentsAttributes'>Order Comments Attributes</a></li>
</ul>


<h3><a name="RESTAPI-Resource-OrderComments-RESTAPI-OrderComments"></a>REST API: Order Comments</h3>

<h4><a name="RESTAPI-Resource-OrderComments-URI--orders--orderid-comments"></a>URI: /orders/:orderid/comments</h4>

<p>Allows you to retrieve information about comments of the required order.</p>

<p><b>URL Structure</b>: http://magentohost/api/rest/orders/:orderid/comments<br/>
<b>Version</b>: 1</p>

<h5><a name="RESTAPI-Resource-OrderComments-HTTPMethod-GET"></a>HTTP Method: GET</h5>

<p><b>Description</b>: Allows you to retrieve information about comments of the required order.</p>

<p><b>Authentication</b>: Admin<br/>
<b>Default Format</b>: XML<br/>
<b>Parameters</b>:<br/>
<em>No Parameters</em></p>

<p><b>Example:</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/33/comments</td></tr></table></div>

<p><b>Response Body:</b></p>
<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;data_item&gt;
    &lt;created_at&gt;2012-03-09 11:20:49&lt;/created_at&gt;
    &lt;comment&gt;&lt;/comment&gt;
    &lt;is_customer_notified&gt;1&lt;/is_customer_notified&gt;
    &lt;is_visible_on_front&gt;0&lt;/is_visible_on_front&gt;
    &lt;status&gt;pending&lt;/status&gt;
  &lt;/data_item&gt;
  &lt;data_item&gt;
    &lt;created_at&gt;2012-03-09 11:21:32&lt;/created_at&gt;
    &lt;comment&gt;This is a new order for John Doe.&lt;/comment&gt;
    &lt;is_customer_notified&gt;1&lt;/is_customer_notified&gt;
    &lt;is_visible_on_front&gt;1&lt;/is_visible_on_front&gt;
    &lt;status&gt;pending&lt;/status&gt;
  &lt;/data_item&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>


<p><b>Authentication</b>: Customer<br/>
<b>Default Format</b>: XML<br/>
<b>Parameters</b>:<br/>
<em>No Parameters</em></p>

<p><b>Example:</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/33/comments</td></tr></table></div>

<p><b>Response Body:</b></p>
<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;data_item&gt;
    &lt;created_at&gt;2012-03-09 11:21:32&lt;/created_at&gt;
    &lt;comment&gt;This is a new order for John Doe.&lt;/comment&gt;
  &lt;/data_item&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>


<h5><a name="RESTAPI-Resource-OrderComments-HTTPMethod-POST"></a>HTTP Method: POST</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderComments-HTTPMethod-PUT"></a>HTTP Method: PUT</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderComments-HTTPMethod-DELETE"></a>HTTP Method: DELETE</h5>

<p><b>Description</b>: Not allowed.</p>



<h3><a name="RESTAPI-Resource-OrderComments-OrderCommentsAttributes"></a>Order Comments Attributes</h3>


<table><tbody>
<tr>
<th> Attribute Name </th>
<th> Attribute Description </th>
<th> Notes </th>
</tr>
<tr>
<td> Comment Date </td>
<td> Date when the comment was added </td>
<td> Admin and Customer </td>
</tr>
<tr>
<td> Comment Text </td>
<td> Comment text </td>
<td> Admin and Customer </td>
</tr>
<tr>
<td> Is Customer Notified </td>
<td> Defines whether the customer is notified about the comment. Can have the following values: 0 - Customer is not notified, 1 - Customer is notified. </td>
<td> Admin only </td>
</tr>
<tr>
<td> Is Comment Visible on Frontend </td>
<td> Defines whether the comment is visible on the frontend.&nbsp;Can have the following values: 0 - Comment is not visible, 1 - Comment is visible. </td>
<td> Admin only <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> Comment Status </td>
<td> Comment status. </td>
<td> Admin only <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>



		    
